/*
 * Copyright 2021 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.realm.kotlin.notifications.internal

/**
 * A _cancellable_ representing ongoing tasks or subscription that can be cancelled.
 */
// Made public to be accessible from sync progress listener notifications
public interface Cancellable {
    public fun cancel()

    public companion object {
        public val NO_OP_NOTIFICATION_TOKEN: Cancellable = object : Cancellable {
            override fun cancel() { /* Do Nothing */
            }
        }
    }
}
